Day 20 | 提交缺陷報告 - iT 邦幫忙::一起幫忙解決難題，拯救 IT 人的一天

2022 iThome 鐵人賽

DAY 20

自我挑戰組

開始系統測試系列第 20 篇

Day 20 | 提交缺陷報告

14th鐵人賽

Pancy

2022-10-05 01:34:18

1332 瀏覽

分享至

缺陷報告的寫作準則(5C)
- correct(準確) - 每個組成部分的描述準確，不會引起誤會
- clear(清晰) - 每個組成部份的描述清晰，易於理解
- concise(簡潔) - 只包含必要的訊息，不包含任何多餘的內容
- complete(完整) - 包含重現該缺陷的完整步驟和其他本質訊息
- consistent(一致) - 按照一致的格式書寫缺陷報告
缺陷報告的組織結構
- 缺陷的標題/缺陷摘要/缺陷概述/缺陷基本訊息
- 前置條件 - 根據實際狀況來寫，不是每次都需要寫
- 重現步驟
- 期望結果
- 實際結果
- 缺陷的嚴重程度
- 缺陷的優先級
- 測試的軟體和硬體環境
- 測試的軟體版本
- 缺陷的類型
- 註釋文字和缺陷截圖
缺陷報告的組織結構與寫作要求
1. 缺陷的標題/缺陷摘要/缺陷概述/缺陷基本訊息
  - 盡量按照缺陷發生的原因與結果的方式書寫
    - 執行完A後，發生B
    - 在XX地方，做了XX事件，發生XX結果；等連結詞有助於描述缺陷的原因和結果
  - 避免使用模糊不清的詞語
  - 為了方便搜尋，盡量使用關鍵字
  - 為了便於他人理解，避免使用專業術語、俚語或過分具體的測試細節
2. 前置條件 - 根據實際狀況來寫，不是每次都需要寫
3. 重現步驟
  - 提供測試的預備步驟和訊息
  - 步驟完整、準確、簡短，沒有缺漏任何操作步驟，也沒有多餘的步驟
  - 將常見的步驟合併為較少的步驟
  - 每一個步驟盡量只記錄一個操作
  - 每一個步驟前用數字對步驟編號
  - 盡量使用短句，避免複雜句型
  - 只記錄操作步驟，不包含每個步驟的執行結果。
4. 期望結果
  - 軟體應該要有的結果，或者正確結果應該是什麼樣子
5. 實際結果
  - 實際結果的描述要列出具體的表現行為，而不是只簡單地說「不正確」
  - 如果一個動作產生彼此不同的多個缺陷結果；或者一個動作產生一個結果，而該結果又產生另一個結果，為了容易閱讀，這些結果應該使用數字列表分隔開來
    - 1.顯示「欄位驗證失敗」
    - 2.系統閃退
6. 缺陷的嚴重程度
7. 缺陷的優先級
8. 測試的軟體和硬體環境
9. 測試的軟體版本
10. 缺陷的類型
11. 註釋文字和缺陷截圖
  - 可以包含以下各方面內容
    - 擷取缺陷圖片
    - 測試過程中所使用的測試文件
    - 測試附加的印表機驅動程式
    - 再次描述重點，避免開發將缺陷退回給測試人員補充更多訊息
    - 再次指明該缺線是否在前一版本已經存在
    - 多個平台之間是否有不同表現
    - 指出缺陷具體的影響範圍
如何提交高品質的缺陷報告
- 盡早提交缺陷報告
- 清楚的說明這個異常對於用戶價值的危害
- 盡可能提供更多的技術訊息(如包含重現該缺陷需要的環境設定或測試所使用的數據文件)，方便開發人員調試。
- 報告的軟體缺陷進行了必要的隔離，報告的缺陷訊息具體、準確
- 容易搜索軟體測試報告的缺陷
- 一種缺陷報告只報告了一個缺陷
- 缺陷報告中不要提問題
- 避免常見的錯誤
  - 我、你、他/她
  - 情緒化的語言和強調符號